ATSUClearAttributes

OSStatus ATSUClearAttributes (
                     ATSUStyle iStyle,
                     ItemCount iTagCount,
                     ATSUAttributeTag iTag[]);

iStyle

A reference of type ATSUStyle. Pass a reference to a valid style object whose attributes you want to remove. You cannot pass NULL for this parameter.

iTagCount

The number of attributes you want to remove. To remove all previously set attributes, pass the constant kATSUClearAll in this parameter. In this case, the value in the iTag parameter will be ignored.

iTag

An array of values of type ATSUAttributeTag. Each element in the array must contain a valid tag that identifies the style run attribute value you want to remove. See Style Run Attribute Tag Constants for a description of the Apple-defined style run attribute tag constants. If you pass a text layout attribute tag constants or an ATSUI-reserved tag constant in this parameter, ATSUClearAttributes returns the result code kATSUInvalidAttributeTagErr.

function result

A result code. See Result Codes. You can remove unset attribute values from a style object without a function error.

DISCUSSION

The ATSUClearAttributes function removes those previously set style run attribute values, including application-defined attributes, that are identified by tag constants in the iTag array. It replaces them with the default style run attribute values described in Table C-1.

If you wish to remove all previously set style run attribute values from a style object, pass kATSUClearAll in the iTagCount parameter. To remove all previously set style run attribute, font feature, and font variation values from a style object, call the function ATSUClearStyle. To remove all previously set font variation values from a style object, call the function ATSUClearFontVariations. To remove all previously set font feature types and selectors from a style object, call the function ATSUClearFontFeatures.

VERSION NOTES

Available beginning with ATSUI 1.0.